<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::session::Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload, S_SHM_TYPE_OR_NONE, S_SHM_MAX_HNDL_SZ, S_GRACEFUL_FINISH_REQUIRED_V &gt;::Open_channel_req Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1session.html">session</a></li><li class="navelem"><a class="el" href="classipc_1_1session_1_1Server__session__impl.html">Server_session_impl</a></li><li class="navelem"><a class="el" href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html">Open_channel_req</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::session::Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload, S_SHM_TYPE_OR_NONE, S_SHM_MAX_HNDL_SZ, S_GRACEFUL_FINISH_REQUIRED_V &gt;::Open_channel_req Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>An open-channel request out-message.  
 <a href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ipc::session::Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload, S_SHM_TYPE_OR_NONE, S_SHM_MAX_HNDL_SZ, S_GRACEFUL_FINISH_REQUIRED_V &gt;::Open_channel_req:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req__coll__graph.svg" width="360" height="191"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa1a85c280c8144f3dfd4ba069de2eb0a"><td class="memItemLeft" align="right" valign="top">Mdt_builder_ptr::element_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#aa1a85c280c8144f3dfd4ba069de2eb0a">m_mdt_builder</a></td></tr>
<tr class="memdesc:aa1a85c280c8144f3dfd4ba069de2eb0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a class="el" href="structipc_1_1session_1_1Client__session__impl_1_1Master__channel__req.html#a91c936c8824be5dfc7112a5b02fc730d" title="The Builder m_req_msg-&gt;body_root()-&gt;getMetadata().">Client_session_impl::Master_channel_req::m_mdt_builder</a>.  <a href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#aa1a85c280c8144f3dfd4ba069de2eb0a">More...</a><br /></td></tr>
<tr class="separator:aa1a85c280c8144f3dfd4ba069de2eb0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a522e6691e46f956648c64877b64d6219"><td class="memItemLeft" align="right" valign="top">Master_structured_channel::Msg_out&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#a522e6691e46f956648c64877b64d6219">m_req_msg</a></td></tr>
<tr class="memdesc:a522e6691e46f956648c64877b64d6219"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a class="el" href="structipc_1_1session_1_1Client__session__impl_1_1Master__channel__req.html#a8cab22f0afe897330ad77a2bc2b536b7" title="The open-channel-request-to-server out-message for the session master channel (in subsequent open_cha...">Client_session_impl::Master_channel_req::m_req_msg</a>.  <a href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#a522e6691e46f956648c64877b64d6219">More...</a><br /></td></tr>
<tr class="separator:a522e6691e46f956648c64877b64d6219"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af46d9d419a695676703311def193044d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1session_1_1Server__session__impl.html#a7c969c3a1007f8e4ba3ad1c1acd6c290">Channel_obj</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#af46d9d419a695676703311def193044d">m_opened_channel</a></td></tr>
<tr class="memdesc:af46d9d419a695676703311def193044d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">transport::Channel</a>, including the needed shared resources acquired, from <a class="el" href="classipc_1_1session_1_1Server__session__impl.html#a138956765a655240080491157f316167" title="See Server_session_mv counterpart.">Server_session_impl::mdt_builder()</a>; or a default-cted such object if that method failed to acquire the needed resources (e.g., MQs).  <a href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#af46d9d419a695676703311def193044d">More...</a><br /></td></tr>
<tr class="separator:af46d9d419a695676703311def193044d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, typename Mdt_payload, schema::ShmType S_SHM_TYPE_OR_NONE, size_t S_SHM_MAX_HNDL_SZ, bool S_GRACEFUL_FINISH_REQUIRED_V&gt;<br />
struct ipc::session::Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload, S_SHM_TYPE_OR_NONE, S_SHM_MAX_HNDL_SZ, S_GRACEFUL_FINISH_REQUIRED_V &gt;::Open_channel_req</div><p >An open-channel request out-message. </p>
<p >Together with that is stored a <code>Builder</code> into its metadata sub-field as well as the already-prepared <a class="el" href="classipc_1_1session_1_1Server__session__impl.html#a7c969c3a1007f8e4ba3ad1c1acd6c290" title="See Server_session_mv counterpart.">Channel_obj</a>, the local <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">transport::Channel</a> peer object in PEER state, since on the server side it is our responsibility acquire the shared resources for both sides.</p>
<p >The design here is identical to Client_session_impl::Open_channel_req; so see its doc header. The only difference is the addition of <a class="el" href="structipc_1_1session_1_1Server__session__impl_1_1Open__channel__req.html#af46d9d419a695676703311def193044d" title="The transport::Channel, including the needed shared resources acquired, from Server_session_impl::mdt...">m_opened_channel</a>; see its doc header just below. </p>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html#l00451">451</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html">server_session_impl.hpp</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="aa1a85c280c8144f3dfd4ba069de2eb0a" name="aa1a85c280c8144f3dfd4ba069de2eb0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1a85c280c8144f3dfd4ba069de2eb0a">&#9670;&nbsp;</a></span>m_mdt_builder</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, typename Mdt_payload , schema::ShmType S_SHM_TYPE_OR_NONE, size_t S_SHM_MAX_HNDL_SZ, bool S_GRACEFUL_FINISH_REQUIRED_V&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">Mdt_builder_ptr::element_type <a class="el" href="classipc_1_1session_1_1Server__session__impl.html">ipc::session::Server_session_impl</a>&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload, S_SHM_TYPE_OR_NONE, S_SHM_MAX_HNDL_SZ, S_GRACEFUL_FINISH_REQUIRED_V &gt;::Open_channel_req::m_mdt_builder</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>See <a class="el" href="structipc_1_1session_1_1Client__session__impl_1_1Master__channel__req.html#a91c936c8824be5dfc7112a5b02fc730d" title="The Builder m_req_msg-&gt;body_root()-&gt;getMetadata().">Client_session_impl::Master_channel_req::m_mdt_builder</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html#l00454">454</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html">server_session_impl.hpp</a>.</p>

</div>
</div>
<a id="af46d9d419a695676703311def193044d" name="af46d9d419a695676703311def193044d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af46d9d419a695676703311def193044d">&#9670;&nbsp;</a></span>m_opened_channel</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, typename Mdt_payload , schema::ShmType S_SHM_TYPE_OR_NONE, size_t S_SHM_MAX_HNDL_SZ, bool S_GRACEFUL_FINISH_REQUIRED_V&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1session_1_1Server__session__impl.html#a7c969c3a1007f8e4ba3ad1c1acd6c290">Channel_obj</a> <a class="el" href="classipc_1_1session_1_1Server__session__impl.html">ipc::session::Server_session_impl</a>&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload, S_SHM_TYPE_OR_NONE, S_SHM_MAX_HNDL_SZ, S_GRACEFUL_FINISH_REQUIRED_V &gt;::Open_channel_req::m_opened_channel</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The <a class="el" href="classipc_1_1transport_1_1Channel.html" title="Peer to a bundle of 1-2 full-duplex pipe(s), one for transmitting unstructured binary blobs; the othe...">transport::Channel</a>, including the needed shared resources acquired, from <a class="el" href="classipc_1_1session_1_1Server__session__impl.html#a138956765a655240080491157f316167" title="See Server_session_mv counterpart.">Server_session_impl::mdt_builder()</a>; or a default-cted such object if that method failed to acquire the needed resources (e.g., MQs). </p>
<p >To test for that failure simply check <a class="el" href="classipc_1_1transport_1_1Channel.html#a43c79955b3ad0eab347550b4263523ec" title="Returns true if and only if the required init_blob_pipe() and init_native_handle_pipe() calls have be...">transport::Channel::initialized()</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html#l00464">464</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html">server_session_impl.hpp</a>.</p>

</div>
</div>
<a id="a522e6691e46f956648c64877b64d6219" name="a522e6691e46f956648c64877b64d6219"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a522e6691e46f956648c64877b64d6219">&#9670;&nbsp;</a></span>m_req_msg</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, typename Mdt_payload , schema::ShmType S_SHM_TYPE_OR_NONE, size_t S_SHM_MAX_HNDL_SZ, bool S_GRACEFUL_FINISH_REQUIRED_V&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">Master_structured_channel::Msg_out <a class="el" href="classipc_1_1session_1_1Server__session__impl.html">ipc::session::Server_session_impl</a>&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload, S_SHM_TYPE_OR_NONE, S_SHM_MAX_HNDL_SZ, S_GRACEFUL_FINISH_REQUIRED_V &gt;::Open_channel_req::m_req_msg</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>See <a class="el" href="structipc_1_1session_1_1Client__session__impl_1_1Master__channel__req.html#a8cab22f0afe897330ad77a2bc2b536b7" title="The open-channel-request-to-server out-message for the session master channel (in subsequent open_cha...">Client_session_impl::Master_channel_req::m_req_msg</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html#l00456">456</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html">server_session_impl.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>session/detail/<a class="el" href="ipc__session_2src_2ipc_2session_2detail_2server__session__impl_8hpp_source.html">server_session_impl.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:39 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
